Get Engagement Link API Now Supports Optional Survey ID Parameter

Automations

What's new?

The GET /engagements/getLink endpoint now accepts an optional Survey_Id query parameter, giving API users more control over which engagement link is generated. Previously, the endpoint always returned a link based on the customer's configured default engagement. You can now pass a specific Survey_Id to generate a link for a targeted engagement instead. The updated request pattern is:

GET /engagements/getLink?apiKey={API_KEY}&candidateId={CANDIDATE_ID}&Survey_Id={SURVEY_ID}

If Survey_Id is omitted, the endpoint behaves exactly as before. If an invalid, deleted, or inaccessible Survey ID is provided, the endpoint silently falls back to the default engagement with no errors thrown.

Why does it matter?

For teams using multiple engagement surveys, this removes the need to change the default engagement configuration just to generate a link for a specific one. It makes the API more flexible for automated workflows that need to target different engagements dynamically, while keeping the endpoint fully backward compatible with existing integrations.

How do I enable this?

No configuration changes are required. The Survey_Id parameter is optional and available immediately. API documentation on the settings tab has been updated to reflect the new parameter and its fallback behavior.